<!DOCTYPE html><html><head>
<title>critcl::emap - C Runtime In Tcl (CriTcl)</title>
<style type="text/css"><!--
    HTML {
	background: 	#FFFFFF;
	color: 		black;
    }
    BODY {
	background: 	#FFFFFF;
	color:	 	black;
    }
    DIV.doctools {
	margin-left:	10%;
	margin-right:	10%;
    }
    DIV.doctools H1,DIV.doctools H2 {
	margin-left:	-5%;
    }
    H1, H2, H3, H4 {
	margin-top: 	1em;
	font-family:	sans-serif;
	font-size:	large;
	color:		#005A9C;
	background: 	transparent;
	text-align:		left;
    }
    H1.doctools_title {
	text-align: center;
    }
    UL,OL {
	margin-right: 0em;
	margin-top: 3pt;
	margin-bottom: 3pt;
    }
    UL LI {
	list-style: disc;
    }
    OL LI {
	list-style: decimal;
    }
    DT {
	padding-top: 	1ex;
    }
    UL.doctools_toc,UL.doctools_toc UL, UL.doctools_toc UL UL {
	font:		normal 12pt/14pt sans-serif;
	list-style:	none;
    }
    LI.doctools_section, LI.doctools_subsection {
	list-style: 	none;
	margin-left: 	0em;
	text-indent:	0em;
	padding: 	0em;
    }
    PRE {
	display: 	block;
	font-family:	monospace;
	white-space:	pre;
	margin:		0%;
	padding-top:	0.5ex;
	padding-bottom:	0.5ex;
	padding-left:	1ex;
	padding-right:	1ex;
	width:		100%;
    }
    PRE.doctools_example {
	color: 		black;
	background: 	#f5dcb3;
	border:		1px solid black;
    }
    UL.doctools_requirements LI, UL.doctools_syntax LI {
	list-style: 	none;
	margin-left: 	0em;
	text-indent:	0em;
	padding:	0em;
    }
    DIV.doctools_synopsis {
	color: 		black;
	background: 	#80ffff;
	border:		1px solid black;
	font-family:	serif;
	margin-top: 	1em;
	margin-bottom: 	1em;
    }
    UL.doctools_syntax {
	margin-top: 	1em;
	border-top:	1px solid black;
    }
    UL.doctools_requirements {
	margin-bottom: 	1em;
	border-bottom:	1px solid black;
    }
--></style>
</head>
<!-- Generated from file 'critcl_emap.man' by tcllib/doctools with format 'html'
   -->
<!-- Copyright &amp;copy; 2011-2018 Andreas Kupries
   -->
<!-- critcl::emap.n
   -->
<body><hr> [
   <a href="../toc.html">Table Of Contents</a>
| <a href="../index.html">Keyword Index</a>
 ] <hr>
<div class="doctools">
<h1 class="doctools_title">critcl::emap(n) 1.2 doc &quot;C Runtime In Tcl (CriTcl)&quot;</h1>
<div id="name" class="doctools_section"><h2><a name="name">Name</a></h2>
<p>critcl::emap - CriTcl Utilities: Enum en- and decoding</p>
</div>
<div id="toc" class="doctools_section"><h2><a name="toc">Table Of Contents</a></h2>
<ul class="doctools_toc">
<li class="doctools_section"><a href="#toc">Table Of Contents</a></li>
<li class="doctools_section"><a href="#synopsis">Synopsis</a></li>
<li class="doctools_section"><a href="#section1">Description</a></li>
<li class="doctools_section"><a href="#section2">API</a></li>
<li class="doctools_section"><a href="#section3">Example</a></li>
<li class="doctools_section"><a href="#section4">Authors</a></li>
<li class="doctools_section"><a href="#section5">Bugs, Ideas, Feedback</a></li>
<li class="doctools_section"><a href="#keywords">Keywords</a></li>
<li class="doctools_section"><a href="#category">Category</a></li>
<li class="doctools_section"><a href="#copyright">Copyright</a></li>
</ul>
</div>
<div id="synopsis" class="doctools_section"><h2><a name="synopsis">Synopsis</a></h2>
<div class="doctools_synopsis">
<ul class="doctools_requirements">
<li>package require <b class="pkgname">Tcl 8.4</b></li>
<li>package require <b class="pkgname">critcl <span class="opt">?3.1.11?</span></b></li>
<li>package require <b class="pkgname">critcl::emap <span class="opt">?1.2?</span></b></li>
</ul>
<ul class="doctools_syntax">
<li><a href="#1"><b class="cmd">::critcl::emap::def</b> <i class="arg">name</i> <i class="arg">definition</i> <span class="opt">?<b class="option">-nocase</b>?</span> <span class="opt">?<b class="option">-mode</b> <i class="arg">mode</i>?</span></a></li>
</ul>
</div>
</div>
<div id="section1" class="doctools_section"><h2><a name="section1">Description</a></h2>
<p><i class="term">C Runtime In Tcl</i>, or <i class="term"><a href="critcl_pkg.html">CriTcl</a></i> , is a system for compiling C code
embedded in Tcl on the fly and either loading the resulting objects into Tcl for
immediate use or packaging them for distribution.  Use <i class="term"><a href="critcl_pkg.html">CriTcl</a></i> to improve
performance by rewriting in C those routines that are performance bottlenecks.</p>
<p>This document is the reference manpage for the
<b class="package">critcl::emap</b> package. This package provides convenience
commands for advanced functionality built on top of both critcl core
and package <b class="package"><a href="critcl_iassoc.html">critcl::iassoc</a></b>.</p>
<p>C level libraries often use enumerations or integer values to encode
information, like the state of a system. Tcl bindings to such libraries now
have the task of converting a Tcl representation, i.e. a string into such
state, and back.
<em>Note</em> here that the C-level information has to be something which
already exists. The package does <em>not</em> create these values. This is
in contrast to the package <b class="package"><a href="critcl_enum.html">critcl::enum</a></b> which creates an
enumeration based on the specified symbolic names.</p>
<p>This package was written to make the declaration and management
of such enumerations and their associated conversions functions easy,
hiding all attendant complexity from the user.</p>
<p>Its intended audience are mainly developers wishing to write
Tcl packages with embedded C code.</p>
<p>This package resides in the Core Package Layer of CriTcl.</p>
<p><img alt="arch_core" src="../image/arch_core.png"></p>
</div>
<div id="section2" class="doctools_section"><h2><a name="section2">API</a></h2>
<dl class="doctools_definitions">
<dt><a name="1"><b class="cmd">::critcl::emap::def</b> <i class="arg">name</i> <i class="arg">definition</i> <span class="opt">?<b class="option">-nocase</b>?</span> <span class="opt">?<b class="option">-mode</b> <i class="arg">mode</i>?</span></a></dt>
<dd><p>This command defines C functions for the conversion of the <i class="arg">name</i>d
state code into a Tcl string, and vice versa.
The underlying mapping tables are automatically initialized on first
access (if not fully constant), and finalized on interpreter
destruction.</p>
<p>The <i class="arg">definition</i> dictionary provides the mapping from the
Tcl-level symbolic names of the state to their C expressions (often
the name of the macro specifying the actual value).
<em>Note</em> here that the C-level information has to be something which
already exists. The package does <em>not</em> create these values. This is
in contrast to the package <b class="package"><a href="critcl_enum.html">critcl::enum</a></b> which creates an
enumeration based on the specified symbolic names.</p>
<p>Further note that multiple strings can be mapped to the same C
expression. When converting to Tcl the first string for the mapping is
returned. An important thing to know: If all C expressions are
recognizable as integer numbers and their covered range is not too
large (at most 50) the package will generate code using direct and
fast mapping tables instead of using a linear search.</p>
<p>If the option <b class="option">-nocase</b> is specified then the encoder
will match strings case-insensitively, and the decoder will always
return a lower-case string, regardless of the string's case in the
<i class="arg">definition</i>.</p>
<p>If the option <b class="option">-mode</b> is specified its contents will
interpreted as a list of access modes to support.  The two allowed
modes are <b class="const">c</b> and <b class="const">tcl</b>. Both modes can be used
together. The default mode is <b class="const">tcl</b>.</p>
<p>The package generates multiple things (declarations and
definitions) with names derived from <i class="arg">name</i>, which has to be a
proper C identifier. Some of the things are generated conditional on
the chosen <i class="arg">mode</i>s.</p>
<dl class="doctools_definitions">
<dt><i class="arg">name</i>_encode</dt>
<dd><p>The <b class="const">tcl</b>-mode function for encoding a Tcl string into the
equivalent state code.
Its signature is</p>
<pre class="doctools_example">
int <i class="arg">name</i>_encode (Tcl_Interp* interp, Tcl_Obj* state, int* result);
</pre>
<p>The return value of the function is a Tcl error code,
i.e. <b class="const">TCL_OK</b>, <b class="const">TCL_ERROR</b>, etc.</p></dd>
<dt><i class="arg">name</i>_encode_cstr</dt>
<dd><p>The <b class="const">c</b>-mode function for encoding a C string into the
equivalent state code.
Its signature is</p>
<pre class="doctools_example">
int <i class="arg">name</i>_encode_cstr (const char* state);
</pre>
<p>The return value of the function is the encoded state, or -1 if
the argument is not a vlaid state.</p></dd>
<dt><i class="arg">name</i>_decode</dt>
<dd><p>The <b class="const">tcl</b>-mode function for decoding a state code into the
equivalent Tcl string.
Its signature is</p>
<pre class="doctools_example">
Tcl_Obj* <i class="arg">name</i>_decode (Tcl_Interp* interp, int state);
</pre>
</dd>
<dt><i class="arg">name</i>_decode_cstr</dt>
<dd><p>The <b class="const">c</b>-mode function for decoding a state code into the
equivalent C string.
Its signature is</p>
<pre class="doctools_example">
const char* <i class="arg">name</i>_decode_cstr (int state);
</pre>
<p>The return value of the function is the C string for the state,
or <b class="const">NULL</b> if the <i class="arg">state</i> argument does not contain a valid
state value.</p></dd>
<dt><i class="arg">name</i>.h</dt>
<dd><p>A header file containing the declarations for the conversion
functions, for use by other parts of the system, if necessary.</p>
<p>The generated file is stored in a place where it will not
interfere with the overall system outside of the package, yet also be
available for easy inclusion by package files (<b class="cmd">csources</b>).</p></dd>
<dt><i class="arg">name</i></dt>
<dd><p>For mode <b class="const">tcl</b> the command registers a new argument-type for
<b class="cmd">critcl::cproc</b> with critcl, encapsulating the encoder function.</p></dd>
<dt><i class="arg">name</i></dt>
<dd><p>For mode <b class="const">tcl</b> the command registers a new result-type for
<b class="cmd">critcl::cproc</b> with critcl, encapsulating the decoder function.</p></dd>
</dl></dd>
</dl>
</div>
<div id="section3" class="doctools_section"><h2><a name="section3">Example</a></h2>
<p>The example shown below is the specification for the possible modes of
entry (normal, no feedback, stars) used by the Tcl binding to the
linenoise library.</p>
<pre class="doctools_example">
package require Tcl 8.5
package require critcl 3.1.11
critcl::buildrequirement {
    package require critcl::emap
}
critcl::emap::def hiddenmode {
            no  0 n 0 off 0 false 0 0 0
    all   1 yes 1 y 1 on  1 true  1 1 1
    stars 2
} -nocase
# Declarations: hiddenmode.h
# Encoder:      int      hiddenmode_encode (Tcl_Interp* interp, Tcl_Obj* state, int* result);
# Decoder:      Tcl_Obj* hiddenmode_decode (Tcl_Interp* interp, int state);
# ResultType:   hiddenmode
# ArgumentType: hiddenmode
</pre>
</div>
<div id="section4" class="doctools_section"><h2><a name="section4">Authors</a></h2>
<p>Andreas Kupries</p>
</div>
<div id="section5" class="doctools_section"><h2><a name="section5">Bugs, Ideas, Feedback</a></h2>
<p>This document, and the package it describes, will undoubtedly contain
bugs and other problems.
Please report such at <a href="https://github.com/andreas-kupries/critcl">https://github.com/andreas-kupries/critcl</a>.
Please also report any ideas for enhancements you may have for either
package and/or documentation.</p>
</div>
<div id="keywords" class="doctools_section"><h2><a name="keywords">Keywords</a></h2>
<p><a href="../index.html#key8">C code</a>, <a href="../index.html#key3">Embedded C Code</a>, <a href="../index.html#key15">Tcl Interp Association</a>, <a href="../index.html#key12">bitmask</a>, <a href="../index.html#key11">bitset</a>, <a href="../index.html#key6">code generator</a>, <a href="../index.html#key0">compile &amp; run</a>, <a href="../index.html#key10">compiler</a>, <a href="../index.html#key1">dynamic code generation</a>, <a href="../index.html#key2">dynamic compilation</a>, <a href="../index.html#key14">flags</a>, <a href="../index.html#key9">generate package</a>, <a href="../index.html#key4">linker</a>, <a href="../index.html#key5">on demand compilation</a>, <a href="../index.html#key7">on-the-fly compilation</a>, <a href="../index.html#key13">singleton</a></p>
</div>
<div id="category" class="doctools_section"><h2><a name="category">Category</a></h2>
<p>Glueing/Embedded C code</p>
</div>
<div id="copyright" class="doctools_section"><h2><a name="copyright">Copyright</a></h2>
<p>Copyright &copy; 2011-2018 Andreas Kupries</p>
</div>
</div></body></html>
